/*
Copyright 2011 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package com.google.rsm.core;

/**
 * Interface representing a state in the state machine.
 * TODO(arunabhaghosh): Add details as this class is fleshed out.
 *
 * @author arunabhaghosh@google.com (Arunabha Ghosh)
 */
public interface State {
  /**
   * Called by the state machine/state enclosing this state to
   * inform the state about an event occurring. Implementations must
   * cast this event to particular Event sub-types to extract any
   * event-specific arguments.
   *
   * @param event the Event which occurred
   */
  void handleEvent(Event event);

  /**
   * Returns true if this state handles events of the given type.
   *
   * @param eventType the type of event to check
   */
  boolean handles(EventType eventType);
}
